home *** CD-ROM | disk | FTP | other *** search
/ C/C++ Users Group Library 1996 July / C-C++ Users Group Library July 1996.iso / vol_200 / 284_01 / cpmfile.doc < prev    next >
Text File  |  1989-03-11  |  8KB  |  188 lines
  1. NAME
  2.     CPMFILE.EXE  CP/M virtual disk access
  3.  
  4. SYNOPSIS
  5.     cpmfile [-webvl] [-d disk] [-u user] [-o file] file ...
  6.  
  7. DESCRIPTION
  8.  
  9.     Please set options as described below:
  10.  
  11.     When more than one character flag (webvl) is used, please 
  12.     attach a dash for each option. 
  13.  
  14.     When the option that requires a parameter is used, it doesn't
  15.     matter whether or not there is a space between the option and 
  16.     parameter.
  17.  
  18.     Although the option can be specified in any order, a file name
  19.     must come after options.
  20.  
  21.     Some combinations of options are restricted. Please refer to the
  22.     detail below where each option is described.
  23.  
  24. w    The program writes a file to the virtual disk. If none of w, e, or l 
  25.     options    is specified, the program reads a file from the virtual disk.
  26.     When w is specified but e is not specified, a file that will be
  27.     written to the disk shouldn't exist in the virtual disk. If it does,
  28.     an error will occur. When both w and e are specified and a file
  29.     that will be written exists in the disk, the file will be removed
  30.     before the operation. The w option can't be used with l or o options.
  31.  
  32.     When a file is written with this option, the CP/M filename
  33.     in the virtual disk and the filename under MSDOS will be the same. 
  34.     Therefore, the file under MSDOS should be in the current directory
  35.     in the current disk.
  36.  
  37. e    The program erases a file in a virtual disk. When w is not
  38.     specified with this option, the file will be erased from the disk.
  39.     When w is specifed with this option, the file will be created after
  40.     it is erased. The e option can't be used with l or o options.
  41.  
  42. l    The program displays filenames in a virtual disk. The l option
  43.     can't be used with w,e, or o options. It can be used with a v option,
  44.     but it makes no difference whether it is with a v option or without it.
  45.  
  46.     The program checks if the specified file exists in the disk and
  47.     displays the only filenames that exist in the disk. A wildcard
  48.     can't be used. Normally, one or more than one file has to be specified,
  49.     but if no filename is specified the program will display all 
  50.     filenames with the specified user number in the disk.
  51.  
  52. v    The program displays currently processing filenames. No filename
  53.     is displayed in default. In the command line of COMPFILE, it is
  54.     possible to specify more than one filename and execute them with
  55.     options. With this option, a filename processed currently is displayed.
  56.  
  57. b    The program treats a file as a binary file. In default, a file 
  58.     is treated as a text file.
  59.  
  60.     Without this option when reading and writing a file, the file will be
  61.     treated as a text file and  transformed. The transformation is 
  62.     performed between the file format of the host operating system and
  63.     the CP/M file format. This feature is designed so that the contents
  64.     of a file would be same between operating systems that have
  65.     different file formats, e.g. UNIX or MVS and CP/M.
  66.     When the host operating system is MSDOS, the transformation described 
  67.     below is performed (although MSDOS and CP/M file foramt are same.)
  68.  
  69.     When the program reads a file from the virtual disk, it searches
  70.     for the end-of-file character, 1AH. When it finds the character,
  71.     the reading of the file terminates. As a result, MSDOS file doesn't
  72.     include 1AH.
  73.  
  74.     When the program writes a file to the virtual disk, it searches for
  75.     the end-of-file character (1AH). When it encounters the character,
  76.     the program acknowledges the end of the file and appends 1AHs until
  77.     the size of the file is a multiple of 128.
  78.  
  79.     When reading or writing a file with the b option, the processed file
  80.     will be treated as a binary file. In both reading and writing 
  81.     operations, the size of the file is the same. The size of the MSDOS 
  82.     file read from the virtual disk is always a multiple of 128. Writing 
  83.     a file, when the size of MSDOS file is a multiple of 128, creates a 
  84.     CP/M file with the same size. However, when the file is not currently
  85.     a multiple of 128, binary 0s are appended until the file size becomes 
  86.     a multiple of 128.
  87.  
  88. o    This options specifies a MSDOS filename read from the virtual disk.
  89.     In default, the same filename as one that is read will be used.
  90.     The o option can't be used with w, e, and l options.
  91.  
  92.     Without this option, the same filename as one that is read will be 
  93.     used. When more than one filenames is specified, more than one MSDOS
  94.     files is created. MSDOS files are created in the current directory
  95.     in the current disk drive.
  96.  
  97.     With this option, the file read from the disk will be named
  98.     as specified with the option. If more than one filenames is
  99.     specified in the command line, all filenames are concatenated in the 
  100.     order.
  101.     A pathname can be specified with this option.
  102.  
  103. u    This option specifies a CP/M user number. The parameter should be
  104.     from 0 to 31, decimal number. The default user number is 0.
  105.     
  106.     In a virtual disk, it is assumed that all CP/M files are in the
  107.     user number specified with this option. Thus, when reading a file,
  108.     displaying a filename, or erasing a file, only files that are in the 
  109.     specified user number will be processed. When writing a file, the file
  110.     is created in the specified user number.
  111.  
  112. d    This option specifies a virtual disk. Although the default has
  113.     an appropriate name, please try to specify on every time. Any MSDOS 
  114.     pathname can be specified for the parameter. The virtual disk must exist
  115.     beforehand even if writing a file to the disk.
  116.  
  117. Filenames
  118.  
  119.     A CP/M filename consists of a
  120.     primary name (Length is less than or equal to 8 characters.),
  121.     , a period, and secondary name (Length is less than or equal 3 
  122.     characters.). No spaces are allowed between characters. If no
  123.     secondary name is included, a period can be omitted.
  124.  
  125.     Upper-case and lower-case characters are not distinguished and
  126.     all characters are treated as upper-case characters.
  127.     No wildcard is allowed.
  128.  
  129. EXAMPLES
  130.  
  131.     This example displays a filename ( in the user number 0) in the
  132.     virtual disk "WORK.DSK".
  133.  
  134.     cpmfile -d word.dsk -l
  135.  
  136.     This example writes MSDOS text files, A.DOC and B.DOC to the disk.
  137.     If there is a file with the same filename, it will be erased before
  138.     writing.
  139.  
  140.     compfile -w -e -d work.dsk a.doc b.doc
  141.  
  142.  
  143.     This example reads a binary file, SAMPLE.COM and writes to 
  144.     a MSDOS file, B:\USER\SAMPLE.CPM. 
  145.     
  146.     cpmfile -b -d work.dsk -o b:\user\sample.cpm sample.com
  147.  
  148.  
  149. BUGS
  150.  
  151.     When reading a file that includes unassigned blocks, the program
  152.     reads until it encounters the unassigned block.
  153.     Moreover, when the program writes a file without the e option
  154.     a file has the same filename as one to be written which exists in the
  155.     disk, and also the file has an unassigned block at the first extent,
  156.     then no error will occur and the writing will processed incorrectly.
  157.  
  158.     The program doesn't check each character of a filename. Therefore, 
  159.     when writing a file, a filename unacceptable under CP/M can be created.
  160.  
  161.     CP/M allows a filename that is unacceptable under MSDOS. 
  162.     When reading this kind of filename, the o option should be used.
  163.  
  164.     Errors about the virtual disk won't be displayed correctly.
  165.  
  166.     When displaying filenames, only files in the specified user number 
  167.     are displayed each time. In order to know in which user number
  168.     a file exists, you need to try all 32 user numbers.
  169.  
  170.     No wildcard can be used.
  171.  
  172.     When writing a file,  a MSDOS file to be written must exist in
  173.     the current directory in the current disk drive.  The same is
  174.     true when reading files. The destination of files must be
  175.     in the current directory in the current disk drive.
  176.  
  177.     The program can't correctly process attributes of CP/M files.
  178.     When a CP/M file has attributes such as "read only",
  179.     "system file", or "archived", the file can't be read or erased.
  180.     When overwriting the file, it will end up with two files that
  181.     have the same file name, one with attributes and one without them.
  182.     The program can't correctly display a filename with attributes.
  183.  
  184.     If processing a non standard text file into a text file without
  185.     the b option, the result may not be the same.
  186.  
  187.  
  188.